Node / meshtastic / Meshtastic-Android / files / core / common / README.md

Displaying Raw • View rendered • Download

Tc9d1d9# `:core:common`

Tc9d1d9## Overview

**Targets:** Android · JVM (Desktop) · iOS

The Ta5d6ff`:core:common` module contains low-level utility functions, extensions, and common data structures that do not depend on any other Meshtastic-specific modules. It is designed to be highly reusable across the project.

Tc9d1d9## Key Components

Tc9d1d9### 1. `util` package

Contains general-purpose extensions and helpers:

Tff7b72- **Coroutines**: Helpers for structured concurrency and Flow transformations.

Tff7b72- **Time**: Utilities for handling timestamps and durations, plus Ta5d6ff`DateFormatter` for display dates.

Tff7b72- **Exceptions**: Standardized exception types for common error scenarios.

Tff7b72- **`NumberFormatter`**: Locale-aware number formatting (pre-format floats before Compose display).

Tff7b72- **`UrlUtils` / `CommonUri`**: URL helpers and a multiplatform URI abstraction.

Tc9d1d9### 2. `MetricFormatter.kt`

Centralized utility for display strings — temperature, voltage, current, percent, humidity, pressure, SNR, RSSI. Ensures consistent unit spacing and formatting across all UI surfaces.

Tc9d1d9### 3. `BuildConfigProvider.kt`

An interface for accessing build-time configuration in a multiplatform-friendly way.

Tc9d1d9## Dependency Graph

<!--region graph-->

Ta5d6ff```Ta5d6ffmermaid

Ta5d6ffgraph TB

:core:common[common]:::kmp-library

classDef android-application fill:#CAFFBF,stroke:#000,stroke-width:2px,color:#000;

classDef android-application-compose fill:#CAFFBF,stroke:#000,stroke-width:2px,color:#000;

classDef compose-desktop-application fill:#CAFFBF,stroke:#000,stroke-width:2px,color:#000;

classDef android-feature fill:#FFD6A5,stroke:#000,stroke-width:2px,color:#000;

classDef android-library fill:#9BF6FF,stroke:#000,stroke-width:2px,color:#000;

classDef android-library-compose fill:#9BF6FF,stroke:#000,stroke-width:2px,color:#000;

classDef android-test fill:#A0C4FF,stroke:#000,stroke-width:2px,color:#000;

classDef jvm-library fill:#BDB2FF,stroke:#000,stroke-width:2px,color:#000;

classDef kmp-feature fill:#FFD6A5,stroke:#000,stroke-width:2px,color:#000;

classDef kmp-library-compose fill:#FFC1CC,stroke:#000,stroke-width:2px,color:#000;

classDef kmp-library fill:#FFC1CC,stroke:#000,stroke-width:2px,color:#000;

classDef unknown fill:#FFADAD,stroke:#000,stroke-width:2px,color:#000;

Ta5d6ff```

<!--endregion-->